home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / p_man / cat3 / X11 / XmbTextExtents.z / XmbTextExtents
Encoding:
Text File  |  2002-10-03  |  5.2 KB  |  133 lines
  1.  
  2.  
  3.  
  4.      XXXXmmmmbbbbTTTTeeeexxxxttttEEEExxxxtttteeeennnnttttssss((((3333XXXX11111111))))XXXX VVVVeeeerrrrssssiiiioooonnnn 11111111 ((((RRRReeeelllleeeeaaaasssseeee 6666....6666))))XXXXmmmmbbbbTTTTeeeexxxxttttEEEExxxxtttteeeennnnttttssss((((3333XXXX11111111))))
  5.  
  6.  
  7.  
  8.      NNNNAAAAMMMMEEEE
  9.           XmbTextExtents, XwcTextExtents - compute text extents
  10.  
  11.      SSSSYYYYNNNNTTTTAAAAXXXX
  12.           int XmbTextExtents(_f_o_n_t__s_e_t, _s_t_r_i_n_g, _n_u_m__b_y_t_e_s,
  13.           _o_v_e_r_a_l_l__i_n_k__r_e_t_u_r_n, _o_v_e_r_a_l_l__l_o_g_i_c_a_l__r_e_t_u_r_n)
  14.                 XFontSet _f_o_n_t__s_e_t;
  15.                 char *_s_t_r_i_n_g;
  16.                 int _n_u_m__b_y_t_e_s;
  17.                 XRectangle *_o_v_e_r_a_l_l__i_n_k__r_e_t_u_r_n;
  18.                 XRectangle *_o_v_e_r_a_l_l__l_o_g_i_c_a_l__r_e_t_u_r_n;
  19.  
  20.           int XwcTextExtents(_f_o_n_t__s_e_t, _s_t_r_i_n_g, _n_u_m__w_c_h_a_r_s,
  21.           _o_v_e_r_a_l_l__i_n_k__r_e_t_u_r_n, _o_v_e_r_a_l_l__l_o_g_i_c_a_l__r_e_t_u_r_n)
  22.                 XFontSet _f_o_n_t__s_e_t;
  23.                 wchar_t *_s_t_r_i_n_g;
  24.                 int _n_u_m__w_c_h_a_r_s;
  25.                 XRectangle *_o_v_e_r_a_l_l__i_n_k__r_e_t_u_r_n;
  26.                 XRectangle *_o_v_e_r_a_l_l__l_o_g_i_c_a_l__r_e_t_u_r_n;
  27.  
  28.      AAAARRRRGGGGUUUUMMMMEEEENNNNTTTTSSSS
  29.           _f_o_n_t__s_e_t  Specifies the font set.
  30.  
  31.           _n_u_m__b_y_t_e_s Specifies the number of bytes in the string
  32.                     argument.
  33.  
  34.           _n_u_m__w_c_h_a_r_s
  35.                     Specifies the number of characters in the string
  36.                     argument.
  37.  
  38.           _o_v_e_r_a_l_l__i_n_k__r_e_t_u_r_n
  39.                     Returns the overall ink dimensions.
  40.  
  41.           _o_v_e_r_a_l_l__l_o_g_i_c_a_l__r_e_t_u_r_n
  42.                     Returns the overall logical dimensions.
  43.  
  44.           _s_t_r_i_n_g    Specifies the character string.
  45.  
  46.      DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  47.           The _X_m_b_T_e_x_t_E_x_t_e_n_t_s and _X_w_c_T_e_x_t_E_x_t_e_n_t_s functions set the
  48.           components of the specified overall_ink_return and
  49.           overall_logical_return arguments to the overall bounding box
  50.           of the string's image and a logical bounding box for spacing
  51.           purposes, respectively.  They return the value returned by
  52.           _X_m_b_T_e_x_t_E_s_c_a_p_e_m_e_n_t or _X_w_c_T_e_x_t_E_s_c_a_p_e_m_e_n_t.  These metrics are
  53.           relative to the drawing origin of the string, using the
  54.           fonts loaded for the specified font set.
  55.  
  56.           If the overall_ink_return argument is non-NULL, it is set to
  57.           the bounding box of the string's character ink.  The
  58.           overall_ink_return for a nondescending, horizontally drawn
  59.           Latin character is conventionally entirely above the
  60.  
  61.  
  62.  
  63.      Page 1                                          (printed 10/3/02)
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.      XXXXmmmmbbbbTTTTeeeexxxxttttEEEExxxxtttteeeennnnttttssss((((3333XXXX11111111))))XXXX VVVVeeeerrrrssssiiiioooonnnn 11111111 ((((RRRReeeelllleeeeaaaasssseeee 6666....6666))))XXXXmmmmbbbbTTTTeeeexxxxttttEEEExxxxtttteeeennnnttttssss((((3333XXXX11111111))))
  71.  
  72.  
  73.  
  74.           baseline; that is, overall_ink_return.height <=
  75.           -overall_ink_return.y.  The overall_ink_return for a
  76.           nonkerned character is entirely at, and to the right of, the
  77.           origin; that is, overall_ink_return.x >= 0.  A character
  78.           consisting of a single pixel at the origin would set
  79.           overall_ink_return fields y = 0, x = 0, width = 1, and
  80.           height = 1.
  81.  
  82.           If the overall_logical_return argument is non-NULL, it is
  83.           set to the bounding box that provides minimum spacing to
  84.           other graphical features for the string.  Other graphical
  85.           features, for example, a border surrounding the text, should
  86.           not intersect this rectangle.
  87.  
  88.           When the _X_F_o_n_t_S_e_t has missing charsets, metrics for each
  89.           unavailable character are taken from the default string
  90.           returned by _X_C_r_e_a_t_e_F_o_n_t_S_e_t so that the metrics represent the
  91.           text as it will actually be drawn.  The behavior for an
  92.           invalid codepoint is undefined.
  93.  
  94.      SSSSEEEEEEEE AAAALLLLSSSSOOOO
  95.           XmbTextEscapement(3X11), XmbTextPerCharExtents(3X11) _X_l_i_b -
  96.           _C _L_a_n_g_u_a_g_e _X _I_n_t_e_r_f_a_c_e
  97.  
  98.  
  99.  
  100.  
  101.  
  102.  
  103.  
  104.  
  105.  
  106.  
  107.  
  108.  
  109.  
  110.  
  111.  
  112.  
  113.  
  114.  
  115.  
  116.  
  117.  
  118.  
  119.  
  120.  
  121.  
  122.  
  123.  
  124.  
  125.  
  126.  
  127.  
  128.  
  129.      Page 2                                          (printed 10/3/02)
  130.  
  131.  
  132.  
  133.